/*
 * MIT License
 *
 * Copyright (c) 2023 北京凯特伟业科技有限公司
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.je.bpm.engine.impl.persistence;

import com.je.bpm.engine.impl.persistence.cache.CachedEntity;
import com.je.bpm.engine.impl.persistence.entity.Entity;
import com.je.bpm.engine.internal.Internal;

import java.util.Collection;

/**
 * Interface to express a condition whether or not a cached entity should be used in the return result of a query.
 */
@Internal
public interface CachedEntityMatcher<EntityImpl extends Entity> {

    /**
     * Returns true if an entity from the cache should be retained (i.e. used as return result for a query).
     * <p>
     * Most implementations of this interface probably don't need this method,
     * and should extend the simpler {@link CachedEntityMatcherAdapter}, which hides this method.
     * <p>
     * Note that the databaseEntities collection can be null, in case only the cache is checked.
     */
    boolean isRetained(Collection<EntityImpl> databaseEntities, Collection<CachedEntity> cachedEntities, EntityImpl entity, Object param);

}
